package com.seed.core.pojo.service;

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.seed.core.exception.ServiceException;
import com.seed.core.pojo.dto.SeedMessageDTO;
import com.seed.core.pojo.entity.SeedBaseEntity;
import com.seed.core.pojo.manager.SeedSystemManager;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;

/**
 * @author gchiaway
 * 日期: 2020-07-20
 * 时间: 14:35
 */
public interface SeedSystemService<Entity extends SeedBaseEntity> extends SeedBaseService {

    /**
     * 获取 entity 的 class
     *
     * @return {@link Class<Entity>}
     */
    Class<Entity> getEntityClass();

    /**
     * 获取对应 entity 的 BaseManager
     *
     * @return BaseManager
     */
    SeedSystemManager<Entity> getBaseManager();

    /**
     * 校验请求令牌
     *
     * @param fromActionToken 请求令牌
     * @return 是否有效
     */
    Boolean checkFromActionToken(String fromActionToken);

    /**
     * 过滤excel数据,判断该数据是否允许导入
     *
     * @param data 单条数据
     * @return 是否允许
     */
    SeedMessageDTO excelDataFilter(Entity data) throws ServiceException;

    /**
     * 校验数据,判断该数据是否允许插入
     *
     * @param data 单条数据
     * @return 是否允许
     */
    SeedMessageDTO checkInsertData(Entity data) throws ServiceException;

    /**
     * 校验数据,判断该数据是否允许更新
     *
     * @param data 单条数据
     * @return 是否允许
     */
    SeedMessageDTO checkUpdateData(Entity data) throws ServiceException;

    /**
     * 插入一条记录（选择字段，策略插入）
     *
     * @param entity 实体对象
     * @return 是否成功
     */
    SeedMessageDTO save(Entity entity) throws ServiceException;

    /**
     * 批量插入
     *
     * @param entityList 实体对象集合
     * @return 是否成功
     */
    SeedMessageDTO saveBatch(Collection<Entity> entityList) throws ServiceException;

    /**
     * 插入（批量）
     *
     * @param entityList 实体对象集合
     * @param batchSize  插入批次数量
     */
    SeedMessageDTO saveBatch(Collection<Entity> entityList, int batchSize) throws ServiceException;

    /**
     * 批量修改插入
     *
     * @param entityList 实体对象集合
     */
    SeedMessageDTO saveOrUpdateBatch(Collection<Entity> entityList) throws ServiceException;

    /**
     * 批量修改插入
     *
     * @param entityList 实体对象集合
     * @param batchSize  每次的数量
     */
    SeedMessageDTO saveOrUpdateBatch(Collection<Entity> entityList, int batchSize) throws ServiceException;

    /**
     * 根据 ID 选择修改
     *
     * @param entity 实体对象
     * @return 是否成功
     */
    SeedMessageDTO updateById(Entity entity) throws ServiceException;

    /**
     * 批量修改
     *
     * @param entityList 实体对象集合
     * @return 是否成功
     */
    SeedMessageDTO updateBatch(Collection<Entity> entityList) throws ServiceException;

    /**
     * 根据 UpdateWrapper 条件，更新记录 需要设置sqlset
     *
     * @param updateWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper}
     * @return 是否成功
     */
    SeedMessageDTO update(Wrapper<Entity> updateWrapper) throws ServiceException;

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     * @return 是否成功
     */
    SeedMessageDTO removeById(Serializable id) throws ServiceException;

    /**
     * 删除（根据ID 批量删除）
     *
     * @param idList 主键ID列表
     * @return 是否成功
     */
    SeedMessageDTO removeByIds(Collection<? extends Serializable> idList) throws ServiceException;

    /**
     * 根据 entity 条件，删除记录
     *
     * @param queryWrapper 实体包装类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     * @return 是否成功
     */
    SeedMessageDTO remove(Wrapper<Entity> queryWrapper) throws ServiceException;

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     * @return 对应实体
     */
    Entity getById(Serializable id) throws ServiceException;

    /**
     * 查询（根据ID 批量查询）
     *
     * @param idList 主键ID列表
     */
    List<Entity> listByIds(Collection<? extends Serializable> idList) throws ServiceException;

    /**
     * 根据 Wrapper，查询一条记录 <br/>
     * <p>结果集，如果是多个会返回第一条</p>
     * <p>随机取一条加上限制条件 wrapper.last("LIMIT 1")</p>
     *
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     * @return 第一条记录
     */
    Entity getOne(Wrapper<Entity> queryWrapper) throws ServiceException;

    /**
     * 查询列表
     *
     * @return 实体对象
     */
    List<Entity> list() throws ServiceException;

    /**
     * 查询列表
     *
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     * @return 实体对象
     */
    List<Entity> list(Wrapper<Entity> queryWrapper) throws ServiceException;

    /**
     * 分页查询
     *
     * @param page 分页对象
     * @return 分页对象
     */
    IPage<Entity> page(IPage<Entity> page) throws ServiceException;

    /**
     * 分页查询
     *
     * @param page         分页对象
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     * @return 分页对象
     */
    IPage<Entity> page(IPage<Entity> page, Wrapper<Entity> queryWrapper) throws ServiceException;

    /**
     * 根据 Wrapper 条件，查询总记录数
     *
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     */
    int count(Wrapper<Entity> queryWrapper) throws ServiceException;
}
